From 658fa07f1e845b0b7458b30f58479ad109e92cd2 Mon Sep 17 00:00:00 2001 From: Robert Lipe Date: Sun, 28 Feb 2016 18:05:24 -0600 Subject: [PATCH] Add missing doc for mtk_locus, transform rptdigits, globalsat options, etc. --- .../filters/options/transform-rptdigits.xml | 13 +++++++++++++ xmldoc/formats/mtk_locus.xml | 12 ++++++++++++ .../formats/options/garmin_gpi-writecodec.xml | 6 ++++++ .../formats/options/globalsat-dump-file.xml | 19 +++++++++++++++++++ .../options/globalsat-input-is-dump-file.xml | 4 ++++ xmldoc/formats/options/globalsat-showlist.xml | 9 +++++++++ xmldoc/formats/options/globalsat-track.xml | 9 +++++++++ xmldoc/formats/options/gpx-split.xml | 1 + 8 files changed, 73 insertions(+) create mode 100644 xmldoc/filters/options/transform-rptdigits.xml create mode 100644 xmldoc/formats/mtk_locus.xml create mode 100644 xmldoc/formats/options/garmin_gpi-writecodec.xml create mode 100644 xmldoc/formats/options/globalsat-dump-file.xml create mode 100644 xmldoc/formats/options/globalsat-input-is-dump-file.xml create mode 100644 xmldoc/formats/options/globalsat-showlist.xml create mode 100644 xmldoc/formats/options/globalsat-track.xml create mode 100644 xmldoc/formats/options/gpx-split.xml diff --git a/xmldoc/filters/options/transform-rptdigits.xml b/xmldoc/filters/options/transform-rptdigits.xml new file mode 100644 index 000000000..e6feb7571 --- /dev/null +++ b/xmldoc/filters/options/transform-rptdigits.xml @@ -0,0 +1,13 @@ + +This option lets you configure how many digits GPSBabel uses for numbering generated route point names. + + +When GPSBabel creates route points during the transformation process these points are sequentially numbered and named "RPTxxx" where xxx represent the number. By default GPSBabel uses 3 digits for these numbers. Rationale: This way a large number of route points can be uniquely named while the generated names are limited to 6 characters. This limitation is imposed by specific GPS-devices. + + +Using this option GPSBabel can be configured to use less or more digits for the generated names. This option is best used in conjunction with the rptname option. + + +Convert a GPX track to a GPX route, deleting the original track, using 2 digits for the generated numbers. +gpsbabel -i gpx -f track.gpx -x transform,wpt=trk,del,rptdigits=2 -o gpx -F route.gpx + diff --git a/xmldoc/formats/mtk_locus.xml b/xmldoc/formats/mtk_locus.xml new file mode 100644 index 000000000..48ff78d8e --- /dev/null +++ b/xmldoc/formats/mtk_locus.xml @@ -0,0 +1,12 @@ + +This format is a protocol supports the MediaTek MT3339, a GPS +chipset that shipped around 2011 that has internal logging capability. +It is the +core of at least two GPS modules, including the +GlobalTop PA6H and the Fastrax IT530. The GlobalTop PA6H module is in +turn the heart of the Adafruit "Ultimate" GPS breakout board, popular +in the Arduino "maker" world. + + +It is similar to the mtk and mtk-bin formats for earlier Mediatek parts. + diff --git a/xmldoc/formats/options/garmin_gpi-writecodec.xml b/xmldoc/formats/options/garmin_gpi-writecodec.xml new file mode 100644 index 000000000..d0c549d4f --- /dev/null +++ b/xmldoc/formats/options/garmin_gpi-writecodec.xml @@ -0,0 +1,6 @@ + +This lets you overwride the default codec of 'windows-1252' when writing +strings in Garmin GPI files. This option may be removed in future versions +of GPSBabel as it's not known which Garmin devices support which character +sets. + diff --git a/xmldoc/formats/options/globalsat-dump-file.xml b/xmldoc/formats/options/globalsat-dump-file.xml new file mode 100644 index 000000000..419e04337 --- /dev/null +++ b/xmldoc/formats/options/globalsat-dump-file.xml @@ -0,0 +1,19 @@ + +The dump-file option is primarly for debugging is module. It lets you +provide a file which contains the raw stream of bytes coming from the +device. This is useful for capturing device state to describe to a +developer that can't actually access hte physical device as well as mocking +the entire device for automated regression testing. + + + +gpsbabel +-i glboalsat,dump-file=gh625xt.bin -f /dev/ttyUSB0 + +can be used to read the device and store its state in the file gh625xt.bin. That file can then be distributed and someone else can +read it with a command line: + + gpsbabel +-i globalsat,input-is-dump-file=1 -f gh625xt.bin -o gpx -F test.gpx + + diff --git a/xmldoc/formats/options/globalsat-input-is-dump-file.xml b/xmldoc/formats/options/globalsat-input-is-dump-file.xml new file mode 100644 index 000000000..e29ce4ffe --- /dev/null +++ b/xmldoc/formats/options/globalsat-input-is-dump-file.xml @@ -0,0 +1,4 @@ + +This is the companion to dump-file and is used to tell the reader that +the code is talking to a stored file and not physical hardware. + diff --git a/xmldoc/formats/options/globalsat-showlist.xml b/xmldoc/formats/options/globalsat-showlist.xml new file mode 100644 index 000000000..5da7914b4 --- /dev/null +++ b/xmldoc/formats/options/globalsat-showlist.xml @@ -0,0 +1,9 @@ + +The showlist argment displays the list of tracks stored on the device. + + + Command showing list of tracks on device + + gpsbabel -i globalsat,showlist=1 -f /dev/ttyUSB0 + + diff --git a/xmldoc/formats/options/globalsat-track.xml b/xmldoc/formats/options/globalsat-track.xml new file mode 100644 index 000000000..c7af15362 --- /dev/null +++ b/xmldoc/formats/options/globalsat-track.xml @@ -0,0 +1,9 @@ + +The 'track' option is used to fetch a single named track, probably one you +learned about via the 'showlist' option from a previous invocation, instead +of fetching all the tracks, which is our default. + + + Command track can be used to fetch a single track, defult is all tracks + gpsbabel -i globalsat,track=number -f /dev/ttyUSB0 -o gpx,garminextensions -F outfile.gpx + diff --git a/xmldoc/formats/options/gpx-split.xml b/xmldoc/formats/options/gpx-split.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/gpx-split.xml @@ -0,0 +1 @@ + -- 2.30.2